<html>
   <head>
      <meta http-equiv="Content-Type" content="text/html; charset=utf-8"/>
      <link rel="stylesheet" type="text/css" href="style.css" />
   </head>
   <body onload="if (top.frames['componentsframe'] == undefined) { s = window.location.toString(); window.location = 'index.html?p=' + s.substring(s.lastIndexOf('/')+1); }">
<h2 class="comptitle">Simple Module <i>BaseMacLayer</i></h2>
<b>Package:</b> org.mixim.base.modules<br/><b>File: <a href="src-base-modules-BaseMacLayer.ned.html">src/base/modules/BaseMacLayer.ned</a></b><br/><p><a href="../doxy/a00026.html" target="mainframe"><b>C++ definition</b></a></p>

<p>Base module for every mac layer module</p>
<img src="org.mixim.base.modules.BaseMacLayer-type.png" ismap="yes" usemap="#type-diagram"/><map name="type-diagram">
<area shape="rect" href="org.mixim.base.modules.BaseMacLayer.html" title="BaseMacLayer" alt="BaseMacLayer" coords="0,30,121,70">
</map>
<h3 class="subtitle">Usage diagram:</h3>
<p>The following diagram shows usage relationships between types.
Unresolved types are missing from the diagram. Click <a href="full-ned-usage-diagram.html">here</a> to see the full picture.</p>
<img src="org.mixim.base.modules.BaseMacLayer-usage.png" ismap="yes" usemap="#usage-diagram"/><map name="usage-diagram"><area shape="rect" href="org.mixim.base.modules.BaseMacLayer.html" title="Simple Module BaseMacLayer" alt="BaseMacLayer" coords="7,16,105,40">
</map>
<h3 class="subtitle">Inheritance diagram:</h3>
<p>The following diagram shows inheritance relationships for this type.
Unresolved types are missing from the diagram. Click <a href="full-ned-inheritance-diagram.html">here</a> to see the full picture.</p>
<img src="org.mixim.base.modules.BaseMacLayer-inheritance.png" ismap="yes" usemap="#inheritance-diagram"/><map name="inheritance-diagram"><area shape="rect" href="org.mixim.base.modules.BaseMacLayer.html" title="Simple Module BaseMacLayer" alt="BaseMacLayer" coords="323,88,421,112">
<area shape="rect" href="org.mixim.modules.mac.BMacLayer.html" title="Simple Module BMacLayer" alt="BMacLayer" coords="7,160,84,184">
<area shape="rect" href="org.mixim.modules.mac.csma.html" title="Simple Module csma" alt="csma" coords="108,160,180,184">
<area shape="rect" href="org.mixim.modules.mac.CSMAMacLayer.html" title="Simple Module CSMAMacLayer" alt="CSMAMacLayer" coords="204,160,311,184">
<area shape="rect" href="org.mixim.modules.mac.LMacLayer.html" title="Simple Module LMacLayer" alt="LMacLayer" coords="335,160,409,184">
<area shape="rect" href="org.mixim.modules.mac.Mac80211.html" title="Simple Module Mac80211" alt="Mac80211" coords="433,160,505,184">
<area shape="rect" href="org.mixim.examples.analogueModels.SimpleMacLayer.html" title="Simple Module SimpleMacLayer" alt="SimpleMacLayer" coords="529,160,639,184">
<area shape="rect" href="org.mixim.modules.mac.UWBIRMac.html" title="Simple Module UWBIRMac" alt="UWBIRMac" coords="663,160,740,184">
<area shape="rect" href="org.mixim.base.modules.BaseLayer.html" title="Simple Module BaseLayer" alt="BaseLayer" coords="284,16,356,40">
<area shape="rect" href="org.mixim.base.modules.IWirelessMac.html" title="Module Interface IWirelessMac" alt="IWirelessMac" coords="380,16,468,40">
</map>
<h3 class="subtitle">Extends:</h3>
<table class="typestable">
   <tr>
      <th class="name">Name</th>
      <th class="type">Type</th>
      <th class="description">Description</th>
   </tr>
<tr>
   <td>
<a href="org.mixim.base.modules.BaseLayer.html">BaseLayer</a>
   </td>
   <td>
<i>simple&nbsp;module</i>
   </td>
   <td>

<p>Base module for all layer modules. Defines the in and out gates</p>

   </td>
</tr>
</table>
<h3 class="subtitle">Known subclasses:</h3>
<table class="typestable">
   <tr>
      <th class="name">Name</th>
      <th class="type">Type</th>
      <th class="description">Description</th>
   </tr>
<tr>
   <td>
<a href="org.mixim.modules.mac.BMacLayer.html">BMacLayer</a>
   </td>
   <td>
<i>simple&nbsp;module</i>
   </td>
   <td>

<p>Implementation of B-MAC (called also Berkeley MAC, Low Power Listening or 
LPL).
See C++ documentation for details.</p>

   </td>
</tr>
<tr>
   <td>
<a href="org.mixim.modules.mac.csma.html">csma</a>
   </td>
   <td>
<i>simple&nbsp;module</i>
   </td>
   <td>

<p>Generic CSMA protocol supporting Mac-ACKs as well as
constant, linear or exponential backoff times.</p>

   </td>
</tr>
<tr>
   <td>
<a href="org.mixim.modules.mac.CSMAMacLayer.html">CSMAMacLayer</a>
   </td>
   <td>
<i>simple&nbsp;module</i>
   </td>
   <td>

<p>CSMA MAC protocol</p>

   </td>
</tr>
<tr>
   <td>
<a href="org.mixim.modules.mac.LMacLayer.html">LMacLayer</a>
   </td>
   <td>
<i>simple&nbsp;module</i>
   </td>
   <td>

<p>Implementation of L-MAC (Lightweight Medium Access Protocol for
Wireless Sensor Networks)</p>

   </td>
</tr>
<tr>
   <td>
<a href="org.mixim.modules.mac.Mac80211.html">Mac80211</a>
   </td>
   <td>
<i>simple&nbsp;module</i>
   </td>
   <td>

<p>Implementation of the 802.11b MAC protocol. This module is intended
to be used in combination with the Decider80211 as decider for the 
physical layer.</p>

   </td>
</tr>
<tr>
   <td>
<a href="org.mixim.examples.analogueModels.SimpleMacLayer.html">SimpleMacLayer</a>
   </td>
   <td>
<i>simple&nbsp;module</i>
   </td>
   <td>
<i>(no description)</i>
   </td>
</tr>
<tr>
   <td>
<a href="org.mixim.modules.mac.UWBIRMac.html">UWBIRMac</a>
   </td>
   <td>
<i>simple&nbsp;module</i>
   </td>
   <td>

<p>This class provides helper function for MAC modules that use the UWB-IR IEEE 802.15.4A model.
Just before sending down a packet to the UWBIRPhyLayer, call prepareData(<a href="UWBIRMacPkt.html">UWBIRMacPkt</a>* packet).
Just after receiving a packet from the UWBIRPhyLayer, call validatePacket(<a href="UWBIRMacPkt.html">UWBIRMacPkt</a>* packet)
and check the returned bool value to know if the packet could be decoded successfully.</p>

   </td>
</tr>
</table>
<h3 class="subtitle">Parameters:</h3>
<table class="paramstable">
   <tr>
      <th class="name">Name</th>
      <th class="type">Type</th>
      <th class="defaultvalue">Default value</th>
      <th class="description">Description</th>
   </tr>
<tr class="inherited">
   <td>notAffectedByHostState</td>
   <td>
      <i>bool</i>
   </td>
   <td>false</td>
   <td>
   </td>
</tr>
<tr class="local">
   <td>coreDebug</td>
   <td>
      <i>bool</i>
   </td>
   <td>false</td>
   <td>
<p>debug switch</p>
   </td>
</tr>
<tr class="local">
   <td>headerLength</td>
   <td>
      <i>int</i>
   </td>
   <td></td>
   <td>
<p>length of the MAC packet header (in bits)</p>
   </td>
</tr>
<tr class="local">
   <td>address</td>
   <td>
      <i>string</i>
   </td>
   <td>"auto"</td>
   <td>
<p>MAC address as hex string (12 hex digits), or
"auto". "auto" values will be replaced by
a generated MAC address in init stage 1.</p>
   </td>
</tr>
</table>
<h3 class="subtitle">Properties:</h3>
<table class="propertiestable">
   <tr>
      <th class="name">Name</th>
      <th class="value">Value</th>
      <th class="description">Description</th>
   </tr>
<tr>
   <td>class</td>
   <td><i>BaseMacLayer</i></td>
   <td></td>
</tr>
</table>
<h3 class="subtitle">Gates:</h3>
<table class="gatestable">
   <tr>
      <th class="name">Name</th>
      <th class="type">Direction</th>
      <th class="gatesize">Size</th>
      <th class="description">Description</th>
   </tr>
<tr class="inherited">
   <td>upperLayerIn</xsl:if></td>
   <td><i>input</i></td>
   <td></td>   <td>
<p>from upper layer</p>
</td>
</tr>
<tr class="inherited">
   <td>upperLayerOut</xsl:if></td>
   <td><i>output</i></td>
   <td></td>   <td>
<p>to uppe layer</p>
</td>
</tr>
<tr class="inherited">
   <td>upperControlIn</xsl:if></td>
   <td><i>input</i></td>
   <td></td>   <td>
<p>control from upper layer</p>
</td>
</tr>
<tr class="inherited">
   <td>upperControlOut</xsl:if></td>
   <td><i>output</i></td>
   <td></td>   <td>
<p>control to upper layer</p>
</td>
</tr>
<tr class="inherited">
   <td>lowerLayerIn</xsl:if></td>
   <td><i>input</i></td>
   <td></td>   <td>
<p>from lower layer</p>
</td>
</tr>
<tr class="inherited">
   <td>lowerLayerOut</xsl:if></td>
   <td><i>output</i></td>
   <td></td>   <td>
<p>to lower layer</p>
</td>
</tr>
<tr class="inherited">
   <td>lowerControlIn</xsl:if></td>
   <td><i>input</i></td>
   <td></td>   <td>
<p>control from lower layer</p>
</td>
</tr>
<tr class="inherited">
   <td>lowerControlOut</xsl:if></td>
   <td><i>output</i></td>
   <td></td>   <td>
<p>control to lower layer</p>
</td>
</tr>
</table>
<h3 class="subtitle">Source code:</h3>
<pre class="src"><span style="color: #808080; font-style: italic; ">// Base module for every mac layer module
</span><span style="color: #800000; font-weight: bold; ">simple</span><span style="color: #000000; "> </span><span style="color: #000000; ">BaseMacLayer</span><span style="color: #000000; "> </span><span style="color: #800000; font-weight: bold; ">extends</span><span style="color: #000000; "> </span><span style="color: #000000; ">BaseLayer</span><span style="color: #000000; "> </span><span style="color: #800000; font-weight: bold; ">like</span><span style="color: #000000; "> </span><span style="color: #000000; ">IWirelessMac</span><span style="color: #000000; ">
{
    </span><span style="color: #800000; font-weight: bold; ">parameters</span><span style="color: #000000; ">:
        </span><span style="color: #000000; font-weight: bold; ">@class</span><span style="color: #000000; ">(</span><span style="color: #000000; ">BaseMacLayer</span><span style="color: #000000; ">);
        </span><span style="color: #000080; font-weight: bold; ">bool</span><span style="color: #000000; "> </span><span style="color: #000000; ">coreDebug</span><span style="color: #000000; "> = </span><span style="color: #800000; font-weight: bold; ">default</span><span style="color: #000000; ">(</span><span style="color: #008000; ">false</span><span style="color: #000000; ">);          </span><span style="color: #808080; font-style: italic; ">// debug switch
</span><span style="color: #000000; ">        </span><span style="color: #000080; font-weight: bold; ">int</span><span style="color: #000000; "> </span><span style="color: #000000; ">headerLength</span><span style="color: #000000; "> </span><span style="color: #000000; font-weight: bold; ">@unit</span><span style="color: #000000; ">(</span><span style="color: #000000; ">bit</span><span style="color: #000000; ">);           </span><span style="color: #808080; font-style: italic; ">// length of the MAC packet header (in bits)
</span><span style="color: #000000; ">        </span><span style="color: #000080; font-weight: bold; ">string</span><span style="color: #000000; "> </span><span style="color: #000000; ">address</span><span style="color: #000000; "> = </span><span style="color: #800000; font-weight: bold; ">default</span><span style="color: #000000; ">(</span><span style="color: #008000; ">&quot;auto&quot;</span><span style="color: #000000; ">);         </span><span style="color: #808080; font-style: italic; ">// MAC address as hex string (12 hex digits), or
</span><span style="color: #000000; ">                                                  </span><span style="color: #808080; font-style: italic; ">// &quot;auto&quot;. &quot;auto&quot; values will be replaced by
</span><span style="color: #000000; ">                                                  </span><span style="color: #808080; font-style: italic; ">// a generated MAC address in init stage 1.
</span><span style="color: #000000; ">}
</span></pre>
   <hr><p class="footer"><a href="http://creativecommons.org/licenses/by-sa/3.0" target="_top"><img src="by-sa.png"></a> This documentation is released under the <a href="http://creativecommons.org/licenses/by-sa/3.0" target="_top">Creative Commons license</a></p>
   </body>
</html>
